Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Browse performance fixes #3846

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

alexandrevryghem
Copy link
Member

@alexandrevryghem alexandrevryghem commented Jan 17, 2025

Description

The browse pages currently perform some unnecessary recalculations which cause some performance issues. I updated some Observables to remove useless emits which prevents methods like updatePageWithItems & updatePage from being called twice when switching the sort order for example.

Instructions for Reviewers

List of changes in this PR:

  • Prevented unnecessary scope$ emits in ngOnChanges()
  • Prevented the updatePageWithItems & updatePage methods from being called twice when you update pagination options or sort direction. This is because the whole combineLatest was triggered twice when making those changes, once by the this.currentPagination$/this.currentSort$ and once by the this.route.queryParams. To fix this I created a new observable routeParams$ for each browse section that doesn't emit when the pagination/sort/... parameters are updated
  • Added shareReplay to the requestHref$ observable to BaseDataService's findByHref & findListByHref methods. This will prevent findByHrefs &findListByHrefs who derive their href$ from another Observable call to trigger that Observable over again.

Guidance for how to test or review this PR:

  • Verify the browse functionality still works (should also be more performant specifically on larger code bases)
  • Add a tap console.log to BrowseService#getBrowseEntriesFor's href$ observable at the end and verify that its creation should be triggered only once
  • Add a console.log in both the BrowseByMetadataComponent's updatePage & updatePageWithItems and verify that on first page load it's only called once and it's also only called once when switching the sort order/page size

Checklist

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

@alexandrevryghem alexandrevryghem added component: Discovery related to discovery search or browse system performance / caching Related to performance, caching or embedded objects port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release labels Jan 17, 2025
@alexandrevryghem alexandrevryghem self-assigned this Jan 17, 2025
@alexandrevryghem alexandrevryghem added this to the 9.0 milestone Jan 17, 2025
@tdonohue tdonohue added high priority 1 APPROVAL pull request only requires a single approval to merge labels Jan 17, 2025
@tdonohue tdonohue self-requested a review January 23, 2025 15:42
Copy link

Hi @alexandrevryghem,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 APPROVAL pull request only requires a single approval to merge component: Discovery related to discovery search or browse system high priority merge conflict performance / caching Related to performance, caching or embedded objects port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release
Projects
Status: 🙋 Needs Reviewers Assigned
Development

Successfully merging this pull request may close these issues.

2 participants